<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Module Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">Module Element</p>
<h1>Element Overview</h1>
<div class="section-text">
Report design information common to report designs and 
libraries. This is most of the report except for the body.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Module</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>XML Element:</td>
<td><code>None</code></td></tr>
<tr><td>Extends:</td>
<td>None</td></tr>
<tr><td>Extendable:</td>
<td>No</td></tr>
<tr><td>Abstract:</td>
<td>Yes</td></tr>
<tr><td>Name Space:</td>
<td>None</td></tr>
<tr><td>Name Requirement:</td>
<td>Not Supported</td></tr>
<tr><td>Allows User Properties:</td>
<td>No</td></tr>
<tr><td>Has Style:</td>
<td>No</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-author">author</a></dt>
<dd>The person who created the report.</dd>
<dt><a href="#Property-base">base</a></dt>
<dd>A base directory to use when computing relative links from this report.</dd>
<dt><a href="#Property-colorPalette">colorPalette</a></dt>
<dd>A set of custom color names.</dd>
<dt><a href="#Property-comments">comments</a></dt>
<dd>Text that describes the report design.</dd>
<dt><a href="#Property-configVars">configVars</a></dt>
<dd>List of configuration variables.</dd>
<dt><a href="#Property-createdBy">createdBy</a></dt>
<dd>Name of the tool that created the design.</dd>
<dt><a href="#Property-description">description</a></dt>
<dd>A description presented to the end user of report when it is deployed.</dd>
<dt><a href="#Property-descriptionID">descriptionID</a></dt>
<dd>The resource key for the description.</dd>
<dt><a href="#Property-helpGuide">helpGuide</a></dt>
<dd>External file that provides help information for the report.</dd>
<dt><a href="#Property-images">images</a></dt>
<dd>A list of images embedded in this report.</dd>
<dt><a href="#Property-includeResource">includeResource</a></dt>
<dd>Resource file name which stores the externalized strings.</dd>
<dt><a href="#Property-includeScripts">includeScripts</a></dt>
<dd>The name(s) of JavaScript files to include into this report.</dd>
<dt><a href="#Property-libraries">libraries</a></dt>
<dd>Libraries that are included by this module.</dd>
<dt><a href="#Property-propertyBindings">propertyBindings</a></dt>
<dd>Binds a property from an element to an expression.</dd>
<dt><a href="#Property-scriptLibs">scriptLibs</a></dt>
<dd></dd>
<dt><a href="#Property-subject">subject</a></dt>
<dd></dd>
<dt><a href="#Property-theme">theme</a></dt>
<dd>Specify the theme that is to be used by the design or library.</dd>
<dt><a href="#Property-title">title</a></dt>
<dd>A short description of the report presented to the user when the report is deployed.</dd>
<dt><a href="#Property-titleID">titleID</a></dt>
<dd>The resource key for the title</dd>
<dt><a href="#Property-units">units</a></dt>
<dd>Default units to be used for the report design.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>The module element describes the common characteristics 
between libraries and designs. It provides a wide variety of properties to help 
people understand the module, and provide lists of most components: page setup, 
data sources, data sets, reusable report items, and so on. It also provides a 
list of custom color definitions.</p>

<h4>Name Spaces</h4>

<p>ROM defines a number of <i>name spaces</i> within a report 
design. A name space holds a set of named components. Each name space is 
independent of the other. ROM name spaces are:</p>

  <table class="section-table">
    <thead>
      <tr><td>Name Space</td>
        <td>Contents</td>
      </tr>
    </thead>
    <tr>
      <td>Styles</td>
      <td>Shared styles</td>
    </tr>
    <tr>
      <td>Data Sources</td>
      <td>Data sources (database connections)</td>
    </tr>
    <tr>
      <td>Data Sets</td>
      <td>Queries and other data sources</td>
    </tr>
    <tr>
      <td>Master Pages</td>
      <td>Page definitions.</td>
    </tr>
    <tr>
      <td>Layout Elements</td>
      <td>All visual elements such as lists, tables, etc.</td>
    </tr>
    <tr>
      <td>Parameters</td>
      <td>Report parameters</td>
    </tr>
  </table>

<p>The name is optional for elements that can appear in the 
Layout Elements name space. The name is required for all other elements.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Report Design element</p>
<p>Library element</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-author">author Property</a></h2>

<p class="section-text">The person who created the report.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Author</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The person who created the report. The user can fill this 
in to keep track of the person who wrote the report, or is responsible for 
maintaining the report. This is purely documentation; BIRT does not use this 
property at runtime.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Module element createdBy Property</p></div>

<hr>
<h2><a name="Property-base">base Property</a></h2>

<p class="section-text">A base directory to use when computing relative links from this report.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Base</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A base directory to use when computing relative links 
from this report. Most often used for reports created externally to the server 
and submitted on the fly. Used when computing hyperlinks, library includes, 
image includes and other relative file references.  See the W3C XML Base 
standard for background:
<a href="http://www.w3.org/TR/2001/REC-xmlbase-20010627/">http://www.w3.org/TR/2001/REC-xmlbase-20010627/</a>. 
</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-colorPalette">colorPalette Property</a></h2>

<p class="section-text">A set of custom color names.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/CustomColor.html">CustomColor</a> Structures</td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Color palette</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The developer can define a set of custom color names as 
part of the design. The developer can then reference these names within 
properties. Defining the colors in the palette helps the developer achieve a 
consistent look throughout the report, and allows colors to be refined by 
changing just one place. </p>

<p>Every custom color has three parts: a display name, an 
internal name and an RGB value. The display name is what the developer sees. If 
the palette will be used by people in different countries, then the display name 
can be externalized and translated. The internal name identifies the color 
within the design and in the XML design file. The internal name cannot be 
localized. Finally, the RGB value gives the actual color.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Custom Color structure</p></div>

<hr>
<h2><a name="Property-comments">comments Property</a></h2>

<p class="section-text">Text that describes the report design.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#html">html</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Comments</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Text that describes the report design. It can contain 
embedded HTML. The comments are notes for the people who develop and maintain 
the report. Comments cannot be externalized. BIRT does not use this information 
at runtime, it is purely documentation for the report developer.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>See the <code>helpGuide</code> and the
<code>description</code> properties for a way to provide 
information for the users of the report.</p></div>

<hr>
<h2><a name="Property-configVars">configVars Property</a></h2>

<p class="section-text">List of configuration variables.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ConfigVar.html">ConfigVar</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Config variables</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Reports frequently have deployment-specific dependencies. For example,
developers often use a test database during development, but target a production
database once the report is deployed. Or, an OEM may use a different company
name in report titles for each of their customers. BIRT provides configuration
variables to support such cases. A configuration variable is a name/value pair.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>See the <code>helpGuide</code> and the
<code>description</code> properties for a way to provide 
information for the users of the report.</p>

<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-createdBy">createdBy Property</a></h2>

<p class="section-text">Name of the tool that created the design.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Created by</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Name of the tool that created the design. Designs created 
by BIRT will contain the text &quot;BIRT Version xxx&quot;. Customers or third parties who 
generate designs can insert their product name here. This is purely a 
documentation property; BIRT does not use it at runtime.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>author</code> property</p></div>

<hr>
<h2><a name="Property-description">description Property</a></h2>

<p class="section-text">A description presented to the end user of report when it is deployed.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#html">html</a></td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Description</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A description presented to the end user of report when it 
is deployed. Can contain HTML. Can be externalized. This is a full description, 
and can be shown to the user when using the report in the UI. The actual use of 
this property is determined by the application UI.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>title</code> property</p>
<p><code>helpGuide</code> property</p></div>

<hr>
<h2><a name="Property-descriptionID">descriptionID Property</a></h2>

<p class="section-text">The resource key for the description.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Description key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Localization resource key for the description presented to the end user of report.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p> description property</p>
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-helpGuide">helpGuide Property</a></h2>

<p class="section-text">External file that provides help information for the report.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#uri">uri</a></td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Help guide</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The help guide is an external file that provides help 
information for the report. Help information can include detailed information 
about parameters, report content or other information. The file can be in any 
format supported by the browser. The help guide will open in a separate popup 
window.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>Library element</p></div>

<hr>
<h2><a name="Property-images">images Property</a></h2>

<p class="section-text">A list of images embedded in this report.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/EmbeddedImage.html">EmbeddedImage</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Images</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A design often uses images. Most images in a report will 
be accessed via a URL, or a file deployed externally to the report. However, 
some reports may want to embed an image directly into the report design. 
Embedded images are especially helpful if a report design is generated in a 
custom application and sent to the server for one-time execution.</p>

<p>Images have a name. The name allows an image item to 
reference the embedded image. Scripts can use the image name to retrieve the 
image from the images array:</p>

<pre class="code-block">var img = report.design.images[&quot;MyImage&quot;]</pre></div>
<h3>See Also</h3>

<div class="section-text">
<p>Image item</p></div>

<hr>
<h2><a name="Property-includeResource">includeResource Property</a></h2>

<p class="section-text">Resource file name which stores the externalized strings.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#list">list</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Include resource</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Report designs support externalized strings by storing the resource keys;
which are stored in the resource file. This property stores the resource file
name.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-includeScripts">includeScripts Property</a></h2>

<p class="section-text">The name(s) of JavaScript files to include into this report.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/IncludeScript.html">IncludeScript</a> Structures</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Include scripts</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The name(s) of JavaScript files to include into this 
report. BIRT reads and executes these scripts before calling the
<code>initialize</code> method for the design. The scripts can 
define reusable variables, functions, objects, Java imports and so on. The 
design can contain any number of script includes.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>initialize</code> method</p></div>

<hr>
<h2><a name="Property-libraries">libraries Property</a></h2>

<p class="section-text">Libraries that are included by this module.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/IncludedLibrary.html">IncludedLibrary</a> Structures</td></tr>
<tr><td>Since:</td>
<td>reserved</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>libraries</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Includes a list of libraries.</p></div>

<hr>
<h2><a name="Property-propertyBindings">propertyBindings Property</a></h2>

<p class="section-text">Binds a property from an element to an expression.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/PropertyBinding.html">PropertyBinding</a> Structures</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Property bindings</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>There is requirement that a property value for an elemenet can be overridden at runtime. 
This list is used to bind a property of an element to an expression, user can override the 
value if expression bind to an parameter.</p></div>

<hr>
<h2><a name="Property-scriptLibs">scriptLibs Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td>List of <a href="../structs/ScriptLib.html">ScriptLib</a> Structures</td></tr>
<tr><td>Since:</td>
<td>2.1.1</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Script libraries</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-subject">subject Property</a></h2>

<p class="section-text"></p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.3</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Subject</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>


<hr>
<h2><a name="Property-theme">theme Property</a></h2>

<p class="section-text">Specify the theme that is to be used by the design or library.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../elements/Theme.html">Theme</a> Reference</td></tr>
<tr><td>Since:</td>
<td>2.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Theme</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>When a report/library include another library, it can use one of the theme
provided by the included library. When a theme is applied, the report/library
is able to reuse all the styles contained in this theme.</p></div>

<hr>
<h2><a name="Property-title">title Property</a></h2>

<p class="section-text">A short description of the report presented to the user when the report is deployed.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Title</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>No</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>A short description of the report presented to the user 
when the report is deployed. The string can be externalized. The use of the 
string depends on the application UI used at deployment.</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>description</code> property</p>
<p><code>helpGuide</code> property</p>
<p><code>title</code> property</p></div>

<hr>
<h2><a name="Property-titleID">titleID Property</a></h2>

<p class="section-text">The resource key for the title</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#resourceKey">resourceKey</a></td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Title key</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Visible</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Localization resource key for the title</p></div>
<h3>See Also</h3>

<div class="section-text">
<p><code>title</code> property</p>

<p>&nbsp;</p></div>

<hr>
<h2><a name="Property-units">units Property</a></h2>

<p class="section-text">Default units to be used for the report design.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (units)</td></tr>
<tr><td>Since:</td>
<td>1.0</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Units</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Inherited:</td>
<td>No</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
<tr><td>Property Sheet Visibility:</td>
<td>Hidden</td></tr>
<tr><td>Property Sheet Group:</td>
<td>Top</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>in</td>
<td>in</td>
<td>in</td>
<td></td></tr>
<tr><td>cm</td>
<td>cm</td>
<td>cm</td>
<td></td></tr>
<tr><td>mm</td>
<td>mm</td>
<td>mm</td>
<td></td></tr>
<tr><td>pt</td>
<td>points</td>
<td>pt</td>
<td></td></tr>
<tr><td>pc</td>
<td>picas</td>
<td>pc</td>
<td></td></tr>
<tr><td>em</td>
<td>ems </td>
<td>em</td>
<td></td></tr>
<tr><td>ex</td>
<td>exs</td>
<td>ex</td>
<td></td></tr>
<tr><td>px</td>
<td>pixels</td>
<td>px</td>
<td></td></tr>
<tr><td>%</td>
<td>%</td>
<td>%</td>
<td></td></tr>
</tbody></table><br>
</body>
</html>
